Skip to content

fix(compile-sfc): handle mapped types work with omit and pick #12648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 5, 2025

Conversation

edison1105
Copy link
Member

@edison1105 edison1105 commented Jan 6, 2025

close #12647

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of generic type parameters in type resolution, ensuring accurate resolution of complex utility types combining Omit and Pick.
  • Tests
    • Added a new test case verifying correct resolution of mapped utility types using Omit and Pick.

Copy link

github-actions bot commented Jan 6, 2025

Size Report

Bundles

File Size Gzip Brotli
runtime-dom.global.prod.js 101 kB 38.3 kB 34.5 kB
vue.global.prod.js 159 kB 58.5 kB 52.1 kB

Usages

Name Size Gzip Brotli
createApp (CAPI only) 46.6 kB 18.2 kB 16.6 kB
createApp 54.5 kB 21.2 kB 19.4 kB
createSSRApp 58.8 kB 23 kB 20.9 kB
defineCustomElement 59.5 kB 22.8 kB 20.8 kB
overall 68.6 kB 26.4 kB 24.1 kB

Copy link

pkg-pr-new bot commented Jan 6, 2025

Open in StackBlitz

@vue/compiler-core

npm i https://pkg.pr.new/@vue/compiler-core@12648

@vue/compiler-dom

npm i https://pkg.pr.new/@vue/compiler-dom@12648

@vue/compiler-sfc

npm i https://pkg.pr.new/@vue/compiler-sfc@12648

@vue/compiler-ssr

npm i https://pkg.pr.new/@vue/compiler-ssr@12648

@vue/reactivity

npm i https://pkg.pr.new/@vue/reactivity@12648

@vue/runtime-core

npm i https://pkg.pr.new/@vue/runtime-core@12648

@vue/runtime-dom

npm i https://pkg.pr.new/@vue/runtime-dom@12648

@vue/server-renderer

npm i https://pkg.pr.new/@vue/server-renderer@12648

@vue/shared

npm i https://pkg.pr.new/@vue/shared@12648

vue

npm i https://pkg.pr.new/vue@12648

@vue/compat

npm i https://pkg.pr.new/@vue/compat@12648

commit: c83b10e

@edison1105 edison1105 added ready to merge The PR is ready to be merged. scope: sfc 🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. labels Jan 6, 2025
Copy link

coderabbitai bot commented Jun 5, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

A new test was added to verify the correct resolution of mapped utility types combining Omit, Pick, and Partial in TypeScript. The resolveStringType function in the type resolver was updated to propagate type parameters, ensuring proper handling of generic utility types and fixing issues with resolving complex index types.

Changes

File(s) Change Summary
packages/compiler-sfc/src/script/resolveType.ts Updated resolveStringType to accept and propagate typeParameters, improving generic type resolution.
packages/compiler-sfc/tests/compileScript/resolveType.spec.ts Added a test for mapped utility types using Omit, Pick, and Partial.

Sequence Diagram(s)

sequenceDiagram
    participant TestCase
    participant resolveStringType
    participant resolveBuiltin

    TestCase->>resolveStringType: resolve('OptionalTest')
    resolveStringType->>resolveStringType: (recursive calls with typeParameters)
    resolveStringType->>resolveBuiltin: (for Omit, Pick, Partial)
    resolveBuiltin->>resolveStringType: resolve type arguments (with typeParameters)
    resolveStringType-->>TestCase: resolved prop types
Loading

Assessment against linked issues

Objective Addressed Explanation
Support correct resolution of TypeScript utility types (Partial, Omit, Pick) in index type resolution (#12647)

Poem

In burrows deep, where types entwine,
The rabbit hops through code and line.
With Omit and Pick and Partial's might,
Generics now resolve just right!
Hooray for tests that catch the flaw—
The warren cheers with happy paw! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b73aba4 and c83b10e.

📒 Files selected for processing (1)
  • packages/compiler-sfc/src/script/resolveType.ts (3 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@edison1105
Copy link
Member Author

/ecosystem-ci run

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
packages/compiler-sfc/src/script/resolveType.ts (1)

569-577: Generic parameter check is solid – minor nitpick on variable shadowing

const name = node.typeName.name shadows the outer-scope name identifier introduced a few lines later for the built-in switch. Consider inlining the identifier (node.typeName.name) or choosing a more specific local (e.g. typeNameId) to avoid subtle shadowing mistakes during future refactors.

🧰 Tools
🪛 Biome (1.9.4)

[error] 570-570: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 10ebcef and b73aba4.

📒 Files selected for processing (2)
  • packages/compiler-sfc/__tests__/compileScript/resolveType.spec.ts (1 hunks)
  • packages/compiler-sfc/src/script/resolveType.ts (3 hunks)
🧰 Additional context used
🪛 Biome (1.9.4)
packages/compiler-sfc/src/script/resolveType.ts

[error] 570-570: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Redirect rules
  • GitHub Check: Header rules
  • GitHub Check: Pages changed
  • GitHub Check: test / unit-test-windows
🔇 Additional comments (2)
packages/compiler-sfc/src/script/resolveType.ts (1)

686-700: 👍 Correctly forwards generics for Pick / Omit

Passing typeParameters when resolving the second argument fixes the original issue and is implemented consistently for both utility types.

🧰 Tools
🪛 Biome (1.9.4)

[error] 695-700: Other switch clauses can erroneously access this declaration.
Wrap the declaration in a block to restrict its access to the switch clause.

The declaration is defined in this switch clause:

Unsafe fix: Wrap the declaration in a block.

(lint/correctness/noSwitchDeclarations)

packages/compiler-sfc/__tests__/compileScript/resolveType.spec.ts (1)

281-296: Great regression test

The new case reproduces the reported failure and protects against future regressions. Test reads clearly and asserts both props – thanks!

@vue-bot
Copy link
Contributor

vue-bot commented Jun 5, 2025

📝 Ran ecosystem CI: Open

suite result latest scheduled
radix-vue success success
vant success success
vue-i18n success success
language-tools success success
vuetify success success
primevue success success
test-utils success success
vueuse success success
pinia success success
nuxt success success
quasar success success
vue-simple-compiler success success
vite-plugin-vue success success
vue-macros success success
router success success
vitepress success success

@edison1105 edison1105 merged commit 4eb46e4 into main Jun 5, 2025
15 of 16 checks passed
@edison1105 edison1105 deleted the edison/fix/12647 branch June 5, 2025 02:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔨 p3-minor-bug Priority 3: this fixes a bug, but is an edge case that only affects very specific usage. ready to merge The PR is ready to be merged. scope: sfc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Typescript Partial<> - [@vue/compiler-sfc] Unsupported type when resolving index type
2 participants